pp108 : Property Sheet of Controls, Regions, and App Palettes

Property Sheet of Controls, Regions, and App Palettes

This topic describes the options available in the property sheets for UI elements.

You can right-click a control, region, or App Palette in the Designer Area and choose Properties to view its property sheet. The <UI element name> window appears in the XForms Designer and displays the following options.

However, not all options given below are applicable to all UI elements. Depending on the UI element, appropriate options display in its property sheet.

Note: For information about setting the properties of an XForm and the basic properties of a control, see Setting Properties for Controls, Regions, and App Palettesand Setting Properties of an XForm, respectively.

Table 1. Options available in Property Sheets

Input UI

Description

ID field

Type a unique identifier for the control. This is a design-time property.

Tab Index field

Type a index for the tab order of the control. This is a design-time property.

Model drop-down list

Select an option to specify the model with which the control is to be bound. If not specified, the model of the parent control is considered. By default, child controls inherit the model attributes of their parent controls, so if you set the model attributes on a parent control all its child controls are bound to that model. This is a design-time property.

Reference field

Click , select the business attribute, whose data is to be bound to the control, from the Request - <model name> dialog box that appears, and click OK. A string, which denotes the search path expression (XPath) of the business attribute, displays in the Reference field. This is a design-time property.

Note:

  • When you click See namespaces for prefixes in the Request - <model name> dialog box to view related details, the Namespaces tab of the Model Properties dialog box is displayed.
  • The namespace of the model specified in the Reference field is also displayed as a tooltip.

Enumerated check box

Check to enable the Select and List controls to hold enumerated values. This is a design-time property.

Style Class field

Type the name of the style class to be applied on the control. The specified style class is picked from the style sheets specified for the XForm. This is a design-time property.

Controls radio button

Select to specify that only controls can be added and displayed in an App Palette. This option is only available in the property sheet of an App Palette.

Application radio button

Select to specify that only applications can be added and displayed in an App Palette. This option is only available in the property sheet of an App Palette.

Resizable check box

Select to enable the resizing of the App Palette at run time. This option is only available in the property sheet of an App Palette.

Title Bar check box

Select to display a title bar for the App Palette at run time. This option is only available in the property sheet of an App Palette.

Tooltip field

Type the text to be displayed as a tooltip for the control. You can also specify this value programmatically by setting a value for the title property of the control.

Load content when tab page is selected checkbox

Select to set the control as a load-on-demand control. This means that when a page is loaded for the first time at run time, the control is initialized (loaded with content) only when you click it.

Data set field

Click and specify the data set source in the Pre-fill data source for <control> dialog box.

Checkboxes check box

Check to display the check boxes that appear in a Table control. Clear this option to hide the check boxes. This is a design-time property.

Save Grid State check box

Check to retain the modifications made to a Table control (column size and placement) when an XForm is opened again at run time.

Display ContextMenu check box

Check to enable the context menu for a Table control. Clear this option to hide the context menu. This is a design-time property.

Toggle Columns check box

Check to enable the toggle feature for columns in a Table control. Uncheck this option to disable the toggle feature. This is a design-time property.

Auto Insert check box

Check to add a new, empty row to a Table control when you enter valid data in the last row of the table. This is applicable for a Table control associated with a transactional data model only.

Multiple Selection check box

Check to enable the selection of multiple records in a List control. This is a run-time property.

Source URL field

Type the URL of the XForm to be loaded in the Frame control. The XForm loaded in a Frame is not editable during design time.

Task Part check box

Check to create a task part for the control. Selecting the check box, displays the Task Part Details pane, as described in the table below

Zoom Properties pane

Use the options available to specify Zoom properties, as described in the table below.

ClickChoice pane

Use the options available to specify context-menu options for a control that provide access to related, detailed information. For more information, see Creating ClickChoice Relations.

Data Value pane

Use the options available to specify True and False values for Check controls, as described in the table below.

Collapsibility pane

Use the options available to specify collapsibility properties for the Groupbox control, as described in the table below.

Events pane

Use the options available to specify events for controls, as described in the table below.

Element bar options pane

Use the options available to specify Element bar properties, as described in the table below.

Synchronized Dialog Options pane

Use the options available to specify properties of synchronized dialogs for Table controls, as described in the table below.

Tab Settings pane

Use the options available to specify the orientation and text direction for Tabs in a region, as described in the table below. This option is only available in the property sheet of a Region.

Settings pane

Use the options available to specify details about the controls to be loaded in an App palette, as described in the table below. These are common options that are also available when applications are loaded in an App Palette.

Application Definition pane

Use the options to specify the application definition of the Application to be loaded in an App Palette, as described in the table below. This option is only available in the property sheet of an App Palette.

The following options are available in the Task Part Details pane.

Table 2. Options in the Task Part Details pane

Input UI

Description

Associated Web Services field

Click and select the Web services that are to be associated with the task part. The button is disabled if no model with a Web service is present on the XForm. You must add a Web service to the XForm to associate it with a control in the XForm.

Name field

Select New or Existing, and type the appropriate name in the editable field to define the name of the task part. It is possible to group multiple controls by assigning them to a single task part name.

Not Available Mode radio buttons

Select Hide or Disable to define the control's display mode, when the XForm is opened by users who do not hold write permissions.

The following options are available in the Zoom Properties pane.

Table 3. Options in the Zoom Properties pane

Input UI

Description

Zoom URL field

Type the URL of the XForm to be loaded in the lookup dialog box. Alternatively, click , and select the XForm from the Select URL dialog box. This is a design-time property.

Zoom Field field

Type the XPath of the business attribute to be returned from the lookup page. This is a design-time property.

Before Zoom drop-down list

Select the event handler to be executed before the lookup page is opened.

After Zoom drop-down list

Select the event handler to be executed after the lookup page is closed.

The following options are available in the Data Value pane.

Table 4. Options in the Data Value pane

Input UI

Description

True Value field

Type a value for which the Check control is selected.

False Value field

Type a value for which the Check control is cleared.

The following options are available in the Collapsibility pane.

Table 5. Options in the Collapsibility pane

Input UI

Description

Collapsible check box

Check to make the Groupbox control collapsible. When selected, a button appears in the title bar of the control. Clicking the button, expands or collapses the control. It is set to False, by default.

Expand on load check box

Check to expand the Groupbox on loading an XForm. It is selected, by default.

Load content when group is expanded check box

Sets the control as a load-on-demand control. This means that when a page is loaded for the first time at run time, the control is initialized (loaded with content) only when you expand it.

The following options are available in the Events pane. You can use the Message Map for associating data with the events of a control. For details, see Using Message Map.

Table 6. Options in the Events pane

Input UI

Description

Click drop-down list

Select the method to be executed when you click a Button control.

Data Bind drop-down list

Select the method to be executed before the data is bound to the control.

Change drop-down list

Select the method to be executed when you modify data.

Validate drop-down list

Select the method to be executed when you change the value of a control that is based on custom script validation, and for which you can perform your own validation.

InFocus drop-down list

Select the method to be executed when the control is highlighted or focused upon.

OutFocus drop-down list

Select the method to be executed when the control is taken out of focus.

Collapse drop-down list

Select the method to be executed when you collapse a Groupbox control.

Expand drop-down list

Select the method to be executed when you expand the Groupbox control.

On Row Click drop-down list

Select the method to be executed when you click a row in the Table control.

On Row Select drop-down list

Select the method to be executed when you select a row in the Table control.

On Row Checked drop-down list

Select the method to be executed when you select a check box in the Table control.

On Column Hidden drop-down list

Select the method to be executed when you hide a column in the Table control.

On Set Default drop-down list

Select the method to be executed when you in the Table control.

The following options are available in the Element bar options pane.

Table 7. Options in the Element bar options pane

Input UI

Description

Control bar check box

Check to enable the control bar.

Pagination bar check box

Check to enable the pagination bar.

The following options are available in the Synchronized Dialog Options pane.

Table 8. Options in the Synchronized Dialog Options pane

Input UI

Description

Dialog URL field

Type the URL of the XForm to be used as the synchronized dialog.

On Dialog Open drop-down list

Select an option to specify the event handler to be executed before opening the synchronized dialog.

ID field

Type a unique ID for identifying and referring the synchronized dialog.

Caption field

Type the text to be displayed in the XForm's titlebar and tabcaption.

Description field

Type the text to be displayed in the XForm's titlebar. This will be the display name for the XForm in the navigational tree.

Docked check box

Check to dock the synchronized dialog, when viewed in the Process Platform Classic view.

Left field

Type an integer value to specify the position of the left edge of the synchronized dialog.

Top field

Type an integer value to specify the position of the top edge of the synchronized dialog.

Width field

Type an integer value to specify the width of the synchronized dialog.

Height field

Type an integer value to specify the height of the synchronized dialog.

The following options are available in the Tab Settings pane.

Table 9. Options in the Tab Settings pane

Input UI

Description

Top radio button

Select to position the tabs at the top of the region.

Right radio button

Select to position the tabs to the right side of the region.

Bottom radio button

Select to position the tabs at the bottom of the region.

Left radio button

Select to position the tabs to the left side of the region.

Vertical radio button

Select to display the text in the tab vertically.

Horizontal radio button

Select to display the text in the tab horizontally.

Roller radio button

Select to display a roller to scroll through the tabs at run time.

Extender radio button

Select to display an extender (navigation arrows) to scroll through the tabs at run time.

The following options are available in the Settings pane.

Table 10. Options in the Settings pane

Input UI

Description

Title Bar check box

Check to add a title bar in the App Palette. In case an application is displayed in the App Palette, the title bar is a combination of the Caption and Description, as specified in the application definition.

Store in Preferences check box

Check to save the state of an application in the App Palette as a user preference. If set totrue, the application's state is stored and is retained when the application is launched again.

Dockable check box

Check to enable the App Palette to dock in the region in which it is located.

Display in view manager

Select an option to display the App Palette control in the View Manager ( menu in the toolbar of an App Palette) and define its appearance. Options are:

  • self: The App Palette will be registered as an option in the View Manager menu.
  • none: The App Palette will not be registered as an option in the View Manager menu.
  • custom: The App Palette will be registered as an option in the View Manager. A separator displays that groups all App Palettes with the same custom group name.

The following options are available in the Application Definition pane.

Table 11. Options in the Application Definition pane

Input UI

Description

URL field

Type the URL of the application to be opened in an App Palette.

Id field

Type a unique identifier for the application.

Caption field

Displays the caption of the application. This name will appear in the taskbar as the tab caption. This will also appear as the titlebar text, as a combination of <caption> and <description> if both are different, and <caption> if both are same.

Description field

Displays the description of the application. This name will appear in the titlebar of the application as a combination of <caption> and <description>.

Region field

Type the region in which the App Palette is loaded.

Docked check box

Check to specify that the App Palette will be docked in the region, by default.


Related tasks

Setting Properties for Controls, Regions, and App Palettes
Setting Properties of an XForm